Appointment Management API - TMF646

API Overview

PXC is introducing a new Appointment Management API based on TM Forum’s TMF646 API. The current TMF646 API specification is based on v4 specification of TMForum.

This API will be initially used to book appointments for repair use cases and in the future will be used for appointing needs of the order management systems.

API fundamentals

The API will manage appointment scheduling for partners. It will find available timeslots, create an appointment or retrieve the details for an appointment. It will also provide the capability of modifying an appointment as well as retrieving a list of appointments.

Resource	Endpoint	Operations/Methods
SearchTimeSlot	/searchTimeSlot	POST
Appointment	/appointment	POST
Appointment	/appointment/{id}	GET
Appointment	/appointment/{id}	PATCH
Appointment	/appointment	GET
AppointmentCreateEvent	/listener/appointmentCreateEvent	POST
AppointmentAttributeValueChangeEvent	/listener/appointmentAttributeValueChangeEvent	POST
AppointmentStateChangeEvent	/listener/appointmentStateChangeEvent	POST

Schema Extensions

To accommodate the current PXC requirements the API was extended using the @Type: PXCSearchTimeSlot and PXCAppointment. Also, a subset of the GeographicAddress definitions from the TMForum V5 structure of TMF622 API were added were added to the schema and referenced in the relatedPlace object. This is to present a common way to partners for capturing addresses such a GALK+DC and UPRN as externalIdentifiers.

Note that the red colour font highlights are only relevant to the Internal Implementation of TMF646 API in common services. Those attributes are to be used only between the Mulesoft and Common Services layers.

• Mulesoft based on the request submitted by Partners will derive the attributes in red colour font and send those to the Internal Common Services implementation of TMF646 API.
• When Mulesoft receives a response from the Internal Common Services implementation of TMF646 API, it will NOT expose the details in red colour font to Partners on the TMF646 external implementation.

Authentication and Authorization

TMF646 API exposed to Partners will be hosted in Mulesoft and it will use the same authentication and authorization as existing APIs. Access is secured using OAuth 2.0 JWT issued by PXC’s partner identity platform. Only authenticated and authorized partners may access the API.